PBDTCloseDown

PBDTCloseDown
Header:	Files.h		Carbon status:	Supported

Closes the desktop database, though your application should never do this itself. This function runs synchronously only.

OSErr PBDTCloseDown (
    DTPBPtr paramBlock
);

paramBlock: A pointer to a desktop parameter block.

function result: A result code.

DISCUSSION

Clear all fields (other than input fields) in the parameter block that you pass to Desktop Manager functions. The relevant fields of the parameter block for this function are:

ioResultOn return, the result code of the function. A value of type OSErr.
ioDTRefNumOn input, the desktop database reference number. A value of type SInt16.

System software uses the PBDTCloseDown function to close the desktop database; your application should never use this function, which is described in this section only for completeness. The system software closes the database when the volume is unmounted.

PBDTCloseDown runs synchronously only, and though it will not close down the desktop databases of remote volumes, it will invalidate all local DTRefNum values for remote desktop databases.

When the PBDTCloseDown function closes the database, it frees all resources allocated by PBDTOpenInform or PBDTGetPath.

SPECIAL CONSIDERATIONS

All of the Desktop Manager functions may move or purge memory blocks in the application heap or for some other reason should not be called from within an interrupt. Your application should not call Desktop Manager functions at interrupt time.

AVAILABILITY

Supported in Carbon. Available in Mac OS 8.1 and later when Carbon 1.0.2 or later is present.